Package-level declarations

Types

Link copied to clipboard
class CloseForumTopicAction(messageThreadId: Int) : Action<Boolean>
Link copied to clipboard
class CreateForumTopicAction(name: String, iconColor: IconColor? = null, iconCustomEmojiId: String? = null) : Action<ForumTopic>
Link copied to clipboard
class DeleteForumTopicAction(messageThreadId: Int) : Action<Boolean>
Link copied to clipboard
class EditForumTopicAction(messageThreadId: Int, name: String? = null, iconCustomEmojiId: String? = null) : Action<Boolean>
Link copied to clipboard
class ReopenForumTopicAction(messageThreadId: Int) : Action<Boolean>
Link copied to clipboard

Functions

Link copied to clipboard
inline fun closeForumTopic(messageThreadId: Int): CloseForumTopicAction

Use this method to close an open topic in a forum supergroup chat. The bot must be an administrator in the chat for this to work and must have the can_manage_topics administrator rights, unless it is the creator of the topic. Returns True on success.

Link copied to clipboard

Use this method to close an open 'General' topic in a forum supergroup chat. The bot must be an administrator in the chat for this to work and must have the can_manage_topics administrator rights. Returns True on success.

Link copied to clipboard
inline fun createForumTopic(name: String, iconColor: IconColor? = null, iconCustomEmojiId: String? = null): CreateForumTopicAction

Use this method to create a topic in a forum supergroup chat. The bot must be an administrator in the chat for this to work and must have the can_manage_topics administrator rights. Returns information about the created topic as a ForumTopic object.

Link copied to clipboard
inline fun deleteForumTopic(messageThreadId: Int): DeleteForumTopicAction

Use this method to delete a forum topic along with all its messages in a forum supergroup chat. The bot must be an administrator in the chat for this to work and must have the can_delete_messages administrator rights. Returns True on success.

Link copied to clipboard
inline fun editForumTopic(messageThreadId: Int, name: String? = null, iconCustomEmojiId: String? = null): EditForumTopicAction

Use this method to edit name and icon of a topic in a forum supergroup chat. The bot must be an administrator in the chat for this to work and must have the can_manage_topics administrator rights, unless it is the creator of the topic. Returns True on success.

Link copied to clipboard

Use this method to edit the name of the 'General' topic in a forum supergroup chat. The bot must be an administrator in the chat for this to work and must have the can_manage_topics administrator rights. Returns True on success.

Link copied to clipboard

Use this method to get custom emoji stickers, which can be used as a forum topic icon by any user. Requires no parameters. Returns an Array of Sticker objects.

Link copied to clipboard

Use this method to hide the 'General' topic in a forum supergroup chat. The bot must be an administrator in the chat for this to work and must have the can_manage_topics administrator rights. The topic will be automatically closed if it was open. Returns True on success.

Link copied to clipboard
inline fun reopenForumTopic(messageThreadId: Int): ReopenForumTopicAction

Use this method to reopen a closed topic in a forum supergroup chat. The bot must be an administrator in the chat for this to work and must have the can_manage_topics administrator rights, unless it is the creator of the topic. Returns True on success.

Link copied to clipboard

Use this method to reopen a closed 'General' topic in a forum supergroup chat. The bot must be an administrator in the chat for this to work and must have the can_manage_topics administrator rights. The topic will be automatically unhidden if it was hidden. Returns True on success.

Link copied to clipboard

Use this method to unhide the 'General' topic in a forum supergroup chat. The bot must be an administrator in the chat for this to work and must have the can_manage_topics administrator rights. Returns True on success.

Link copied to clipboard

Use this method to clear the list of pinned messages in a forum topic. The bot must be an administrator in the chat for this to work and must have the can_pin_messages administrator right in the supergroup. Returns True on success.

Link copied to clipboard

Use this method to clear the list of pinned messages in a General forum topic. The bot must be an administrator in the chat for this to work and must have the can_pin_messages administrator right in the supergroup. Returns True on success.